package org.jsola.hr.web;

import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.jsola.core.Page;
import org.jsola.core.Result;
import org.jsola.hr.dto.PolicyCourierTypeAddDTO;
import org.jsola.hr.dto.PolicyCourierTypeUpdateDTO;
import org.jsola.hr.query.PolicyCourierTypeQuery;
import org.jsola.hr.vo.PolicyCourierTypeListVO;
import org.jsola.hr.vo.PolicyCourierTypeVO;

import java.util.List;

/**
 * 政策速递类型
 *
 * @author zhr
 */
@Api(tags = "hr-政策速递类型")
public interface IPolicyCourierTypeControllerAPI {

    /**
     * 新增政策速递类型
     * @param policyCourierTypeAddDTO 政策速递类型新增实体
     * @return 政策速递类型展示对象
     */
    @ApiOperation(value = "新增政策速递类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeAddDTO", dataType = "PolicyCourierTypeAddDTO", value = "新增政策速递类型", paramType = "body")
    })
    Result<PolicyCourierTypeVO> save(PolicyCourierTypeAddDTO policyCourierTypeAddDTO);


    /**
     * 修改政策速递类型
     * @param policyCourierTypeUpdateDTO 政策速递类型
     * @return 更新数量
     */
    @ApiOperation(value = "修改政策速递类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeUpdateDTO", dataType = "PolicyCourierTypeUpdateDTO", value = "修改政策速递类型", paramType = "body")
    })
    Result<Integer> update(PolicyCourierTypeUpdateDTO policyCourierTypeUpdateDTO);




    /**
     * 删除单个政策速递类型，彻底删除
     * @param policyCourierTypeId 政策速递类型id
     * @return 删除数量
     */
    @ApiOperation(value="删除单个政策速递类型，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeId", dataType = "String", value = "政策速递类型id", paramType = "path")
    })
    Result<Integer> delete(String policyCourierTypeId);


    /**
     * 批量删除政策速递类型，彻底删除
     * @param policyCourierTypeIds 政策速递类型id集合
     * @return 删除数量
     */
    @ApiOperation(value = "批量删除政策速递类型，彻底删除")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeIds", dataType = "String[]", value = "政策速递类型id数组", paramType = "body" ,allowMultiple = true)
    })
    Result<Integer> deleteBatch(String[] policyCourierTypeIds);


    /**
     * 根据政策速递类型id查询政策速递类型详情
     * @param policyCourierTypeId 政策速递类型id
     * @return 政策速递类型详情
     */
    @ApiOperation(value="根据政策速递类型id查询政策速递类型详情")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeId", dataType = "String", value = "政策速递类型id", paramType = "path")
    })
    Result<PolicyCourierTypeVO> findById(String policyCourierTypeId);


    /**
     * 查询政策速递类型
     * @param policyCourierTypeQuery 政策速递类型查询参数
     * @return page
     */
    @ApiOperation(value="查询政策速递类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeQuery", dataType = "PolicyCourierTypeQuery", value = "政策速递类型查询参数", paramType = "query")
    })
    Result<List<PolicyCourierTypeListVO>> listAll(PolicyCourierTypeQuery policyCourierTypeQuery);


     /**
     * 分页查询政策速递类型
     * @param policyCourierTypeQuery 政策速递类型查询参数
     * @return page
     */
    @ApiOperation(value="分页查询政策速递类型")
    @ApiImplicitParams({
            @ApiImplicitParam(name = "policyCourierTypeQuery", dataType = "PolicyCourierTypeQuery", value = "政策速递类型查询参数", paramType = "query")
    })
    Result<Page<PolicyCourierTypeListVO>> page(PolicyCourierTypeQuery policyCourierTypeQuery);


}

